home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Misc Servers / Zope.exe / ZSERVICE.PY < prev    next >
Encoding:
Text File  |  2000-06-13  |  11.5 KB  |  314 lines
  1. ##############################################################################
  2. # 
  3. # Zope Public License (ZPL) Version 1.0
  4. # -------------------------------------
  5. # 
  6. # Copyright (c) Digital Creations.  All rights reserved.
  7. # 
  8. # This license has been certified as Open Source(tm).
  9. # 
  10. # Redistribution and use in source and binary forms, with or without
  11. # modification, are permitted provided that the following conditions are
  12. # met:
  13. # 
  14. # 1. Redistributions in source code must retain the above copyright
  15. #    notice, this list of conditions, and the following disclaimer.
  16. # 
  17. # 2. Redistributions in binary form must reproduce the above copyright
  18. #    notice, this list of conditions, and the following disclaimer in
  19. #    the documentation and/or other materials provided with the
  20. #    distribution.
  21. # 
  22. # 3. Digital Creations requests that attribution be given to Zope
  23. #    in any manner possible. Zope includes a "Powered by Zope"
  24. #    button that is installed by default. While it is not a license
  25. #    violation to remove this button, it is requested that the
  26. #    attribution remain. A significant investment has been put
  27. #    into Zope, and this effort will continue if the Zope community
  28. #    continues to grow. This is one way to assure that growth.
  29. # 
  30. # 4. All advertising materials and documentation mentioning
  31. #    features derived from or use of this software must display
  32. #    the following acknowledgement:
  33. # 
  34. #      "This product includes software developed by Digital Creations
  35. #      for use in the Z Object Publishing Environment
  36. #      (http://www.zope.org/)."
  37. # 
  38. #    In the event that the product being advertised includes an
  39. #    intact Zope distribution (with copyright and license included)
  40. #    then this clause is waived.
  41. # 
  42. # 5. Names associated with Zope or Digital Creations must not be used to
  43. #    endorse or promote products derived from this software without
  44. #    prior written permission from Digital Creations.
  45. # 
  46. # 6. Modified redistributions of any form whatsoever must retain
  47. #    the following acknowledgment:
  48. # 
  49. #      "This product includes software developed by Digital Creations
  50. #      for use in the Z Object Publishing Environment
  51. #      (http://www.zope.org/)."
  52. # 
  53. #    Intact (re-)distributions of any official Zope release do not
  54. #    require an external acknowledgement.
  55. # 
  56. # 7. Modifications are encouraged but must be packaged separately as
  57. #    patches to official Zope releases.  Distributions that do not
  58. #    clearly separate the patches from the original work must be clearly
  59. #    labeled as unofficial distributions.  Modifications which do not
  60. #    carry the name Zope may be packaged in any form, as long as they
  61. #    conform to all of the clauses above.
  62. # 
  63. # 
  64. # Disclaimer
  65. # 
  66. #   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
  67. #   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  68. #   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  69. #   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
  70. #   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  71. #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  72. #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  73. #   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  74. #   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  75. #   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  76. #   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  77. #   SUCH DAMAGE.
  78. # 
  79. # 
  80. # This software consists of contributions made by Digital Creations and
  81. # many individuals on behalf of Digital Creations.  Specific
  82. # attributions are listed in the accompanying credits file.
  83. # 
  84. ##############################################################################
  85. """
  86. ZServer as a NT service.
  87.  
  88. The serice starts up and monitors a ZServer process.
  89.  
  90. Features:
  91.   
  92.   * When you start the service it starts ZServer
  93.   * When you stop the serivice it stops ZServer
  94.   * It monitors ZServer and restarts it if it exits abnormally
  95.   * If ZServer is shutdown from the web, the service stops.
  96.   * If ZServer cannot be restarted, the service stops.
  97.  
  98. Usage:
  99.  
  100.   Installation
  101.   
  102.     The ZServer service should be installed by the Zope Windows
  103.     installer. You can manually install, uninstall the service from
  104.     the commandline.
  105.     
  106.       ZService.py [options] install|update|remove|start [...]
  107.           |stop|restart [...]|debug [...]
  108.  
  109.     Options for 'install' and 'update' commands only:
  110.     
  111.      --username domain\username : The Username the service is to run
  112.                                   under
  113.      
  114.      --password password : The password for the username
  115.      
  116.      --startup [manual|auto|disabled] : How the service starts, 
  117.                                         default = manual
  118.   
  119.     Commands
  120.            
  121.       install : Installs the service
  122.      
  123.       update : Updates the service, use this when you change
  124.                ZServer.py
  125.      
  126.       remove : Removes the service
  127.      
  128.       start : Starts the service, this can also be done from the
  129.               services control panel
  130.      
  131.       stop : Stops the service, this can also be done from the
  132.              services control panel
  133.      
  134.       restart : Restarts the service
  135.      
  136.       debug : Runs the service in debug mode
  137.   
  138.     You can view the usage options by running ZServer.py without any
  139.     arguments.
  140.     
  141.     Note: you may have to register the Python service program first,
  142.       
  143.       win32\pythonservice.exe /register
  144.     
  145.   Starting Zope
  146.   
  147.     Start Zope by clicking the 'start' button in the services control
  148.     panel. You can set Zope to automatically start at boot time by
  149.     choosing 'Auto' startup by clicking the 'statup' button.
  150.   
  151.   Stopping Zope
  152.   
  153.     Stop Zope by clicking the 'stop' button in the services control
  154.     panel. You can also stop Zope through the web by going to the
  155.     Zope control panel and by clicking 'Shutdown'. 
  156.   
  157.   Event logging
  158.   
  159.     Zope events are logged to the NT application event log. Use the
  160.     event viewer to keep track of Zope events.
  161.  
  162.   Registry Settings
  163.   
  164.     You can change how the service starts ZServer by editing a registry
  165.     key.
  166.     
  167.       HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\
  168.         <Service Name>\Parameters\start
  169.  
  170.     The value of this key is the command which the service uses to
  171.     start ZServer. For example:
  172.     
  173.       "C:\Program Files\Zope\bin\python.exe"
  174.         "C:\Program Files\Zope\z2.py" -w 8888
  175.  
  176.     
  177. TODO:
  178.  
  179.   * Integrate it into the Windows installer.
  180.   * Add ZLOG logging in addition to event log logging.
  181.   * Make it easier to run multiple Zope services with one Zope install
  182.  
  183. This script does for NT the same sort of thing zdaemon.py does for UNIX.
  184. Requires Python win32api extensions.
  185. """
  186. import sys, os, string, time, imp
  187.  
  188. # Some fancy path footwork is required here because we
  189. # may be run from python.exe or lib/win32/PythonService.exe
  190.  
  191. home=os.path.split(os.path.split(sys.executable)[0])[0]
  192. if sys.executable[-10:]!='python.exe':
  193.     home=os.path.split(home)[0]
  194.     home=os.path.split(home)[0]
  195. sys.path.append(os.path.join(home, 'bin'))
  196. sys.path.append(os.path.join(home, 'ZServer'))
  197. sys.path.append(os.path.join(home, 'bin', 'lib', 'win32'))
  198. sys.path.append(os.path.join(home, 'bin', 'lib', 'win32', 'lib'))
  199.  
  200.  
  201. # pythoncom and pywintypes are special, and require these hacks when
  202. # we dont have a standard Python installation around.
  203.  
  204. import win32api
  205. def magic_import(modulename, filename):
  206.     # by Mark Hammond
  207.     try:
  208.         # See if it does import first!
  209.         return __import__(modulename)
  210.     except ImportError:
  211.         pass
  212.     # win32 can find the DLL name.
  213.     h = win32api.LoadLibrary(filename)
  214.     found = win32api.GetModuleFileName(h)
  215.     # Python can load the module
  216.     mod = imp.load_module(modulename, None, found, ('.dll', 'rb', imp.C_EXTENSION))
  217.     # inject it into the global module list.
  218.     sys.modules[modulename] = mod
  219.     # And finally inject it into the namespace.
  220.     globals()[modulename] = mod
  221.     win32api.FreeLibrary(h)
  222.  
  223. magic_import('pywintypes','pywintypes15.dll')
  224.  
  225. import win32serviceutil, win32service, win32event, win32process
  226. try: import servicemanager
  227. except: pass
  228.  
  229.  
  230.  
  231. class ZServerService(win32serviceutil.ServiceFramework):
  232.  
  233.     # Some trickery to determine the service name. The WISE
  234.     # installer will write an svcname.txt to the ZServer dir
  235.     # that we can use to figure out our service name.
  236.  
  237.     path=os.path.join(home, 'ZServer', 'svcname.txt')
  238.     file=open(path, 'r')
  239.     _svc_name_=string.strip(file.readline())
  240.     file.close()
  241.  
  242.     _svc_display_name_ = "Zope (%s)" % _svc_name_
  243.     
  244.     restart_min_time=5 # if ZServer restarts before this many
  245.                        # seconds then we have a problem, and
  246.                        # need to stop the service.
  247.     
  248.     def __init__(self, args):
  249.         win32serviceutil.ServiceFramework.__init__(self, args)
  250.         self.hWaitStop = win32event.CreateEvent(None, 0, 0, None)
  251.     
  252.     def SvcDoRun(self):
  253.         self.start_zserver()
  254.         while 1:
  255.             rc=win32event.WaitForMultipleObjects(
  256.                     (self.hWaitStop, self.hZServer), 0, win32event.INFINITE)
  257.             if rc - win32event.WAIT_OBJECT_0 == 0:
  258.                 break
  259.             else:
  260.                 self.restart_zserver()
  261.         self.ReportServiceStatus(win32service.SERVICE_STOP_PENDING, 5000)   
  262.  
  263.     def SvcStop(self):
  264.         servicemanager.LogInfoMsg('Stopping Zope.') 
  265.         try:
  266.             self.stop_zserver()              
  267.         except:
  268.             pass
  269.         self.ReportServiceStatus(win32service.SERVICE_STOP_PENDING)
  270.         win32event.SetEvent(self.hWaitStop)
  271.  
  272.     def start_zserver(self):
  273.         sc=self.get_start_command()
  274.         result=win32process.CreateProcess(None, self.get_start_command(),
  275.                 None, None, 0, 0, None, None, win32process.STARTUPINFO())
  276.         self.hZServer=result[0]
  277.         self.last_start_time=time.time()
  278.         servicemanager.LogInfoMsg('Starting Zope.')
  279.         
  280.     def stop_zserver(self):
  281.         win32process.TerminateProcess(self.hZServer,0)
  282.         
  283.     def restart_zserver(self):
  284.         if time.time() - self.last_start_time < self.restart_min_time:
  285.             servicemanager.LogErrorMsg('Zope died and could not be restarted.')
  286.             self.SvcStop()
  287.         code=win32process.GetExitCodeProcess(self.hZServer)
  288.         if code == 0:
  289.             # Exited with a normal status code,
  290.             # assume that shutdown is intentional.
  291.             self.SvcStop()
  292.         else:
  293.             servicemanager.LogWarningMsg('Restarting Zope.')
  294.             self.start_zserver()
  295.  
  296.     def get_start_command(self):
  297.         return win32serviceutil.GetServiceCustomOption(self,'start')
  298.         
  299.         
  300. def set_start_command(value):
  301.     "sets the ZServer start command if the start command is not already set"
  302.     current=win32serviceutil.GetServiceCustomOption(ZServerService,
  303.                                                     'start', None)
  304.     if current is None:
  305.         win32serviceutil.SetServiceCustomOption(ZServerService,'start',value)
  306.             
  307.  
  308. if __name__=='__main__':
  309.     win32serviceutil.HandleCommandLine(ZServerService)
  310.     if 'install' in sys.argv:
  311.         command='"%s" "%s" -S' % (sys.executable, os.path.join(home,'z2.py'))
  312.         set_start_command(command)
  313.         print "Setting ZServer start command to:", command
  314.